.TH gnap_overlay 1 "May 2005" "GNAP"
.SH NAME
gnap_overlay \- Create a GNAP system LiveCD or disk
.SH SYNOPSIS
.B gnap_overlay
-i isoname -o overlay [ options ]

.B gnap_overlay
-d hostdisk -r rootdev -o overlay [ options ]
.SH DESCRIPTION
.B gnap_overlay
will produce a new GNAP system. It can output an ISO file (to be burnt onto a
bootable CD-ROM), or directly write the bootable filesystem to a disk attached
on the current host system. It will start from a GNAP core file, then use the
provided overlay directories and conflets to customize the GNAP system
contents.
.SH COMMON OPTIONS
.TP
.B "\-o" overlay
Use the specified overlay to customize the GNAP system filesystem. The overlay
can be a directory to overlay or a conflet (a tar.bz2 file containing a
directory to overlay).
.TP
.B "\-c" overlay.conf
Use the specified file as /etc/overlay.conf on the GNAP system. The
overlay.conf file is used to configure what the GNAP system does. This option
is used to specify a file whenever it's not already part of an overlay. Note
that this file is mandatory so if the specified
.B "\-o"
overlays don't include an etc/overlay.conf, this parameter is necessary.
.TP
.B "\-g" gnap_core
Location of the GNAP core file to use as a base.
By default, it will use the /usr/lib/gnap/gnap-core-XXX.tar file corresponding
to the current version.
.TP
.B "\-n"
Do not use the GNAP castle logo. GNAP comes with a nifty GNAP bootup logo,
using this option will disable it.
.TP
.B "\-f"
Force all answers to yes. Use at your own risk.
.SH OPTIONS FOR ISO TARGET
.TP
.B "\-i" isoname
Name of the output ISO file.
.SH OPTIONS FOR DISK TARGET
.TP
.B "\-d" hostdisk
Disk partition to write the GNAP filesystem to. This is a disk currently
present, but not mounted, on the system you run gnap_overlay on.
gnap_overlay will
.B destroy all data
present on this partition, use at your own risk.
.TP
.B "\-r" rootdev
This is the name of the boot disk (without the /dev/ prefix), as it will be
seen when plugged on the target GNAP system. This is usually hda1 or sda1.
.TP
.B "\-m"
This option tells GNAP to cache the filesystem contents into memory during
boot, to minimize read operations on the boot media. Especially useful when
installing to CompactFlash cards that have limited lifetime, but takes
valuable memory away.
.TP
.B "\-s" baudrate
This option tells GNAP to display the console on the ttyS0 serial port, and
sets the baudrate to the specified number. For example, if you use
.B "\-s" 19200
, it will use a 19200n81 setting, compatible with Soekris boxes.
.SH EXAMPLES
.B gnap_overlay
-i fwall.iso -o overlays/firewall/

Create a fwall.iso GNAP LiveCD ISO file using the default GNAP core and the
overlays/firewall directory as an overlay.

.B gnap_overlay
-d /dev/sdb1 -r hda1 -o overlays/test/ -m

Write a GNAP bootable filesystem to the disk plugged as /dev/hdc, using the
overlays/test directory as an overlay. The disk will be seen on target system
as hda1, and GNAP will load itself in memory to reduce media wear.
.SH SEE ALSO
.BR gnap_make (1),
.BR gnap_remaster (1)
.SH AUTHOR
.nf
Thierry Carrez (koon@gentoo.org)
.fi
